home *** CD-ROM | disk | FTP | other *** search
/ OpenGL Superbible (2nd Edition) / OpenGL SuperBible e2.iso / tools / GLUT-3.7 / PROGS / DEMOS / SKYFLY / RANDOM.C < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-12  |  14.9 KB  |  377 lines
  1. /*
  2.  * Copyright (c) 1983 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms are permitted
  6.  * provided that the above copyright notice and this paragraph are
  7.  * duplicated in all such forms and that any documentation,
  8.  * advertising materials, and other materials related to such
  9.  * distribution and use acknowledge that the software was developed
  10.  * by the University of California, Berkeley.  The name of the
  11.  * University may not be used to endorse or promote products derived
  12.  * from this software without specific prior written permission.
  13.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16.  */
  17.  
  18. #ifdef __STDC__
  19.         #pragma weak initstate = _initstate
  20.         #pragma weak random    = _random
  21.         #pragma weak setstate  = _setstate
  22.         #pragma weak srandom   = _srandom
  23. #endif
  24. /*#include "synonyms.h"*/
  25.  
  26. #if defined(LIBC_SCCS) && !defined(lint)
  27. static char sccsid[] = "@(#)random.c    5.5 (Berkeley) 7/6/88";
  28. #endif /* LIBC_SCCS and not lint */
  29.  
  30. #include <stdio.h>
  31. #include <stdlib.h>     /* for prototyping */
  32.  
  33. #undef random
  34. long random(void);
  35.  
  36. /*
  37.  * random.c:
  38.  * An improved random number generation package.  In addition to the standard
  39.  * rand()/srand() like interface, this package also has a special state info
  40.  * interface.  The initstate() routine is called with a seed, an array of
  41.  * bytes, and a count of how many bytes are being passed in; this array is then
  42.  * initialized to contain information for random number generation with that
  43.  * much state information.  Good sizes for the amount of state information are
  44.  * 32, 64, 128, and 256 bytes.  The state can be switched by calling the
  45.  * setstate() routine with the same array as was initiallized with initstate().
  46.  * By default, the package runs with 128 bytes of state information and
  47.  * generates far better random numbers than a linear congruential generator.
  48.  * If the amount of state information is less than 32 bytes, a simple linear
  49.  * congruential R.N.G. is used.
  50.  * Internally, the state information is treated as an array of longs; the
  51.  * zeroeth element of the array is the type of R.N.G. being used (small
  52.  * integer); the remainder of the array is the state information for the
  53.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  54.  * state information, which will allow a degree seven polynomial.  (Note: the 
  55.  * zeroeth word of state information also has some other information stored
  56.  * in it -- see setstate() for details).
  57.  * The random number generation technique is a linear feedback shift register
  58.  * approach, employing trinomials (since there are fewer terms to sum up that
  59.  * way).  In this approach, the least significant bit of all the numbers in
  60.  * the state table will act as a linear feedback shift register, and will have
  61.  * period 2^deg - 1 (where deg is the degree of the polynomial being used,
  62.  * assuming that the polynomial is irreducible and primitive).  The higher
  63.  * order bits will have longer periods, since their values are also influenced
  64.  * by pseudo-random carries out of the lower bits.  The total period of the
  65.  * generator is approximately deg*(2**deg - 1); thus doubling the amount of
  66.  * state information has a vast influence on the period of the generator.
  67.  * Note: the deg*(2**deg - 1) is an approximation only good for large deg,
  68.  * when the period of the shift register is the dominant factor.  With deg
  69.  * equal to seven, the period is actually much longer than the 7*(2**7 - 1)
  70.  * predicted by this formula.
  71.  */
  72.  
  73.  
  74.  
  75. /*
  76.  * For each of the currently supported random number generators, we have a
  77.  * break value on the amount of state information (you need at least this
  78.  * many bytes of state info to support this random number generator), a degree
  79.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  80.  * the separation between the two lower order coefficients of the trinomial.
  81.  */
  82.  
  83. #define         TYPE_0          0               /* linear congruential */
  84. #define         BREAK_0         8
  85. #define         DEG_0           0
  86. #define         SEP_0           0
  87.  
  88. #define         TYPE_1          1               /* x**7 + x**3 + 1 */
  89. #define         BREAK_1         32
  90. #define         DEG_1           7
  91. #define         SEP_1           3
  92.  
  93. #define         TYPE_2          2               /* x**15 + x + 1 */
  94. #define         BREAK_2         64
  95. #define         DEG_2           15
  96. #define         SEP_2           1
  97.  
  98. #define         TYPE_3          3               /* x**31 + x**3 + 1 */
  99. #define         BREAK_3         128
  100. #define         DEG_3           31
  101. #define         SEP_3           3
  102.  
  103. #define         TYPE_4          4               /* x**63 + x + 1 */
  104. #define         BREAK_4         256
  105. #define         DEG_4           63
  106. #define         SEP_4           1
  107.  
  108.  
  109. /*
  110.  * Array versions of the above information to make code run faster -- relies
  111.  * on fact that TYPE_i == i.
  112.  */
  113.  
  114. #define         MAX_TYPES       5               /* max number of types above */
  115.  
  116. static  const int       degrees[ MAX_TYPES ]    = { DEG_0, DEG_1, DEG_2,
  117.                                                                 DEG_3, DEG_4 };
  118.  
  119. static  const int       seps[ MAX_TYPES ]       = { SEP_0, SEP_1, SEP_2,
  120.                                                                 SEP_3, SEP_4 };
  121.  
  122.  
  123.  
  124. /*
  125.  * Initially, everything is set up as if from :
  126.  *              initstate( 1, &randtbl, 128 );
  127.  * Note that this initialization takes advantage of the fact that srandom()
  128.  * advances the front and rear pointers 10*rand_deg times, and hence the
  129.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  130.  * element of the state information, which contains info about the current
  131.  * position of the rear pointer is just
  132.  *      MAX_TYPES*(rptr - state) + TYPE_3 == TYPE_3.
  133.  */
  134.  
  135. static  long            randtbl[ DEG_3 + 1 ]    = { TYPE_3,
  136.                             0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342, 
  137.                             0xde3b81e0, 0xdf0a6fb5, 0xf103bc02, 0x48f340fb, 
  138.                             0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd, 
  139.                             0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86, 
  140.                             0xda672e2a, 0x1588ca88, 0xe369735d, 0x904f35f7, 
  141.                             0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc, 
  142.                             0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b, 
  143.                                         0xf5ad9d0e, 0x8999220b, 0x27fb47b9 };
  144.  
  145. /*
  146.  * fptr and rptr are two pointers into the state info, a front and a rear
  147.  * pointer.  These two pointers are always rand_sep places aparts, as they cycle
  148.  * cyclically through the state information.  (Yes, this does mean we could get
  149.  * away with just one pointer, but the code for random() is more efficient this
  150.  * way).  The pointers are left positioned as they would be from the call
  151.  *                      initstate( 1, randtbl, 128 )
  152.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  153.  * in the initialization of randtbl) because the state table pointer is set
  154.  * to point to randtbl[1] (as explained below).
  155.  */
  156.  
  157. static  long            *fptr                   = &randtbl[ SEP_3 + 1 ];
  158. static  long            *rptr                   = &randtbl[ 1 ];
  159.  
  160.  
  161.  
  162. /*
  163.  * The following things are the pointer to the state information table,
  164.  * the type of the current generator, the degree of the current polynomial
  165.  * being used, and the separation between the two pointers.
  166.  * Note that for efficiency of random(), we remember the first location of
  167.  * the state information, not the zeroeth.  Hence it is valid to access
  168.  * state[-1], which is used to store the type of the R.N.G.
  169.  * Also, we remember the last location, since this is more efficient than
  170.  * indexing every time to find the address of the last element to see if
  171.  * the front and rear pointers have wrapped.
  172.  */
  173.  
  174. static  long            *state                  = &randtbl[ 1 ];
  175.  
  176. static  int             rand_type               = TYPE_3;
  177. static  int             rand_deg                = DEG_3;
  178. static  int             rand_sep                = SEP_3;
  179.  
  180. static  long            *end_ptr                = &randtbl[ DEG_3 + 1 ];
  181.  
  182.  
  183.  
  184. /*
  185.  * srandom:
  186.  * Initialize the random number generator based on the given seed.  If the
  187.  * type is the trivial no-state-information type, just remember the seed.
  188.  * Otherwise, initializes state[] based on the given "seed" via a linear
  189.  * congruential generator.  Then, the pointers are set to known locations
  190.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  191.  * information a given number of times to get rid of any initial dependencies
  192.  * introduced by the L.C.R.N.G.
  193.  * Note that the initialization of randtbl[] for default usage relies on
  194.  * values produced by this routine.
  195.  */
  196.  
  197. void
  198. srandom( x )
  199.     unsigned            x;
  200. {
  201.         register  int           i;
  202.  
  203.         if(  rand_type  ==  TYPE_0  )  {
  204.             state[ 0 ] = (long) x;
  205.         }
  206.         else  {
  207.             state[ 0 ] = (long) x;
  208.             for( i = 1; i < rand_deg; i++ )  {
  209.                 state[i] = 1103515245*state[i - 1] + 12345;
  210.             }
  211.             fptr = &state[ rand_sep ];
  212.             rptr = &state[ 0 ];
  213.             for( i = 0; i < 10*rand_deg; i++ )  random();
  214.         }
  215. }
  216.  
  217.  
  218.  
  219. /*
  220.  * initstate:
  221.  * Initialize the state information in the given array of n bytes for
  222.  * future random number generation.  Based on the number of bytes we
  223.  * are given, and the break values for the different R.N.G.'s, we choose
  224.  * the best (largest) one we can and set things up for it.  srandom() is
  225.  * then called to initialize the state information.
  226.  * Note that on return from srandom(), we set state[-1] to be the type
  227.  * multiplexed with the current value of the rear pointer; this is so
  228.  * successive calls to initstate() won't lose this information and will
  229.  * be able to restart with setstate().
  230.  * Note: the first thing we do is save the current state, if any, just like
  231.  * setstate() so that it doesn't matter when initstate is called.
  232.  * Returns a pointer to the old state.
  233.  */
  234.  
  235. char  *
  236. initstate( seed, arg_state, n )
  237.  
  238.     unsigned            seed;                   /* seed for R. N. G. */
  239.     char                *arg_state;             /* pointer to state array */
  240.     size_t              n;                      /* # bytes of state info */
  241. {
  242.         register  char          *ostate         = (char *)( &state[ -1 ] );
  243.  
  244.         if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  245.         else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  246.         if(  n  <  BREAK_1  )  {
  247.             if(  n  <  BREAK_0  )  {
  248.                 fprintf( stderr, "initstate: not enough state (%d bytes) with which to do jack; ignored.\n", n );
  249.                 return 0;
  250.             }
  251.             rand_type = TYPE_0;
  252.             rand_deg = DEG_0;
  253.             rand_sep = SEP_0;
  254.         }
  255.         else  {
  256.             if(  n  <  BREAK_2  )  {
  257.                 rand_type = TYPE_1;
  258.                 rand_deg = DEG_1;
  259.                 rand_sep = SEP_1;
  260.             }
  261.             else  {
  262.                 if(  n  <  BREAK_3  )  {
  263.                     rand_type = TYPE_2;
  264.                     rand_deg = DEG_2;
  265.                     rand_sep = SEP_2;
  266.                 }
  267.                 else  {
  268.                     if(  n  <  BREAK_4  )  {
  269.                         rand_type = TYPE_3;
  270.                         rand_deg = DEG_3;
  271.                         rand_sep = SEP_3;
  272.                     }
  273.                     else  {
  274.                         rand_type = TYPE_4;
  275.                         rand_deg = DEG_4;
  276.                         rand_sep = SEP_4;
  277.                     }
  278.                 }
  279.             }
  280.         }
  281.         state = &(  ( (long *)arg_state )[1]  );        /* first location */
  282.         end_ptr = &state[ rand_deg ];   /* must set end_ptr before srandom */
  283.         srandom( seed );
  284.         if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  285.         else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  286.         return( ostate );
  287. }
  288.  
  289.  
  290.  
  291. /*
  292.  * setstate:
  293.  * Restore the state from the given state array.
  294.  * Note: it is important that we also remember the locations of the pointers
  295.  * in the current state information, and restore the locations of the pointers
  296.  * from the old state information.  This is done by multiplexing the pointer
  297.  * location into the zeroeth word of the state information.
  298.  * Note that due to the order in which things are done, it is OK to call
  299.  * setstate() with the same state as the current state.
  300.  * Returns a pointer to the old state information.
  301.  */
  302.  
  303. char  *
  304. setstate( arg_state )
  305.  
  306.     const char          *arg_state;
  307. {
  308.         register  long          *new_state      = (long *)arg_state;
  309.         register  int           type            = (int)new_state[0]%MAX_TYPES;
  310.         register  int           rear            = (int)new_state[0]/MAX_TYPES;
  311.         char                    *ostate         = (char *)( &state[ -1 ] );
  312.  
  313.         if(  rand_type  ==  TYPE_0  )  state[ -1 ] = rand_type;
  314.         else  state[ -1 ] = MAX_TYPES*(rptr - state) + rand_type;
  315.         switch(  type  )  {
  316.             case  TYPE_0:
  317.             case  TYPE_1:
  318.             case  TYPE_2:
  319.             case  TYPE_3:
  320.             case  TYPE_4:
  321.                 rand_type = type;
  322.                 rand_deg = degrees[ type ];
  323.                 rand_sep = seps[ type ];
  324.                 break;
  325.  
  326.             default:
  327.                 fprintf( stderr, "setstate: state info has been munged; not changed.\n" );
  328.         }
  329.         state = &new_state[ 1 ];
  330.         if(  rand_type  !=  TYPE_0  )  {
  331.             rptr = &state[ rear ];
  332.             fptr = &state[ (rear + rand_sep)%rand_deg ];
  333.         }
  334.         end_ptr = &state[ rand_deg ];           /* set end_ptr too */
  335.         return( ostate );
  336. }
  337.  
  338.  
  339.  
  340. /*
  341.  * random:
  342.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  343.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
  344.  * same in all ther other cases due to all the global variables that have been
  345.  * set up.  The basic operation is to add the number at the rear pointer into
  346.  * the one at the front pointer.  Then both pointers are advanced to the next
  347.  * location cyclically in the table.  The value returned is the sum generated,
  348.  * reduced to 31 bits by throwing away the "least random" low bit.
  349.  * Note: the code takes advantage of the fact that both the front and
  350.  * rear pointers can't wrap on the same call by not testing the rear
  351.  * pointer if the front one has wrapped.
  352.  * Returns a 31-bit random number.
  353.  */
  354.  
  355. long
  356. random(void)
  357. {
  358.         long            i;
  359.         
  360.         if(  rand_type  ==  TYPE_0  )  {
  361.             i = state[0] = ( state[0]*1103515245 + 12345 )&0x7fffffff;
  362.         }
  363.         else  {
  364.             *fptr += *rptr;
  365.             i = (*fptr >> 1)&0x7fffffff;        /* chucking least random bit */
  366.             if(  ++fptr  >=  end_ptr  )  {
  367.                 fptr = state;
  368.                 ++rptr;
  369.             }
  370.             else  {
  371.                 if(  ++rptr  >=  end_ptr  )  rptr = state;
  372.             }
  373.         }
  374.         return( i );
  375. }
  376.  
  377.